/*
 * Copyright 2012-2021 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.springframework.boot.context.config;

import java.io.IOException;

import org.apache.commons.logging.Log;

import org.springframework.boot.BootstrapContext;
import org.springframework.boot.BootstrapRegistry;
import org.springframework.boot.ConfigurableBootstrapContext;
import org.springframework.boot.logging.DeferredLogFactory;

/**
 * 用于加载给定 {@link ConfigDataResource} 的 {@link ConfigData} 的策略类。实现类应作为 {@code spring.factories} 条目添加。
 * 支持以下构造函数参数类型：
 * <ul>
 * <li>{@link Log} 或 {@link DeferredLogFactory} - 如果加载器需要延迟日志记录</li>
 * <li>{@link ConfigurableBootstrapContext} - 一个引导上下文，可用于存储可能创建代价高或需要共享的对象
 * （也可以使用 {@link BootstrapContext} 或 {@link BootstrapRegistry}）。</li>
 * </ul>
 * <p>
 * 多个加载器不能声明加载同一资源。
 *
 * @param <R> 资源类型
 * @author Phillip Webb
 * @author Madhura Bhave
 * @since 2.4.0
 */
public interface ConfigDataLoader<R extends ConfigDataResource> {

	/**
	 * 返回此实例是否能加载指定资源。
	 * @param context 加载器上下文
	 * @param resource 要检查的资源
	 * @return 此加载器是否支持该资源
	 */
	default boolean isLoadable(ConfigDataLoaderContext context, R resource) {
		return true;
	}

	/**
	 * 加载指定资源的 {@link ConfigData}。
	 * @param context 加载器上下文
	 * @param resource 要加载的资源
	 * @return 加载的配置数据，或如果应跳过该位置则返回 {@code null}
	 * @throws IOException IO 错误时抛出
	 * @throws ConfigDataResourceNotFoundException 找不到资源时抛出
	 */
	ConfigData load(ConfigDataLoaderContext context, R resource)
			throws IOException, ConfigDataResourceNotFoundException;

}
